feat(opentelemetry): create otel instrumentation for typed-express-router #1044

starfy84 · 2025-06-25T20:46:52Z

This PR implements opentelemetry instrumentation for the decode and sendEncoded calls in wrapRouter.

Changes:

typed-express-wrapper
- @opentelemetry/api@^1.0.0 added as an optional peer dependency
- @opentelemetry/[email protected] , @opentelemetry/[email protected], and @opentelemetry/[email protected] added as dev dependencies
- wrapRouter modified to create decode and encode spans if @opentelemetry/api is installed
  - if @opentelemetry/api is not installed, spans are not created
- onDecodeError option removed. Please use decodeErrorFormatter and getDecodeErrorStatusCode
  - decodeErrorFormatter takes in an array of ValidationErrors and a WrappedRequest, returning a Json object.
  - getDecodeErrorStatusCode takes in an array of ValidationErrors and a WrappedRequest, returning a number.
- onEncodeError option removed. Please use encodeErrorFormatter and getEncodeErrorStatusCode
  - encodeErrorFormatter takes in an error and a WrappedRequest, returning a Json object.
  - getEncodeErrorStatusCode takes in an error and a WrappedRequest, returning a number.
- typed-express-router now handles the sending of the http response when there is a decode or encode error
express-wrapper
- routerForApiSpec modified to pass in new parameters decodeErrorFormatter, getDecodeErrorStatusCode, encodeErrorFormatter, and getEncodeErrorStatusCode
  - These new parameters can also be customized by modifying the props passed into the function (see CreateRouterProps)

BREAKING CHANGE: onDecodeError and onEncodeError have been removed. Please use decodeErrorFormatter, getDecodeErrorStatusCode, encodeErrorFormatter, and getEncodeErrorStatusCode

packages/opentelemetry-instrumentation-typed-express-router/test/instrumentation.test.ts

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts

packages/opentelemetry-instrumentation-typed-express-router/src/version.ts

packages/opentelemetry-instrumentation-typed-express-router/src/utils.ts

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts

packages/opentelemetry-instrumentation-express/src/terinstrumentation.ts

packages/opentelemetry-instrumentation-express/test/fixtures/use-express.mjs

packages/opentelemetry-instrumentation-express/test/utils.ts

packages/opentelemetry-instrumentation-typed-express-router/src/instrumentation.ts

packages/typed-express-router/src/index.ts

packages/typed-express-router/src/telemetry.ts

packages/typed-express-router/test/telemetry.test.ts

packages/express-wrapper/src/request.ts

packages/typed-express-router/src/errors.ts

packages/typed-express-router/src/types.ts

…uter This commit implements `opentelemetry` instrumentation for the `decode` and `sendEncoded` calls in `wrapRouter`. Changes: - `typed-express-wrapper` - `@opentelemetry/api@^1.0.0` added as an optional peer dependency - `@opentelemetry/[email protected]` , `@opentelemetry/[email protected]`, and `@opentelemetry/[email protected]` added as dev dependencies - `wrapRouter` modified to create decode and encode spans if `@opentelemetry/api` is installed - if `@opentelemetry/api` is not installed, spans are not created - `onDecodeError` option removed. Please use `decodeErrorFormatter` and `getDecodeErrorStatusCode` - `decodeErrorFormatter` takes in an array of `ValidationError`s and a `WrappedRequest`, returning a `Json` object. - `getDecodeErrorStatusCode` takes in an array of `ValidationError`s and a `WrappedRequest`, returning a number. - `onEncodeError` option removed. Please use `encodeErrorFormatter` and `getEncodeErrorStatusCode` - `encodeErrorFormatter` takes in an error and a `WrappedRequest`, returning a `Json` object. - `getEncodeErrorStatusCode` takes in an error and a `WrappedRequest`, returning a number. - `typed-express-router` now handles the sending of the http response when there is a decode or encode error - `express-wrapper` - `routerForApiSpec` modified to pass in new parameters `decodeErrorFormatter`, `getDecodeErrorStatusCode`, `encodeErrorFormatter`, and `getEncodeErrorStatusCode` - These new parameters can also be customized by modifying the props passed into the function (see `CreateRouterProps`) BREAKING CHANGE: `onDecodeError` and `onEncodeError` have been removed. Please use `decodeErrorFormatter`, `getDecodeErrorStatusCode`, `encodeErrorFormatter`, and `getEncodeErrorStatusCode`

ericcrosson-bitgo

Apparently this text box can't be empty.

ericcrosson-bitgo · 2025-07-17T19:35:30Z

packages/express-wrapper/src/request.ts

 };

-export const onEncodeError: OnEncodeErrorFn = (err, _req, res) => {
+export const defaultEncodeErrorFormatter: EncodeErrorFormatterFn = (_err, _req) => {
+  return {};


question: Does this change the behavior of express-wrapper so it sends a JSON body of {}, where previously there was no body?

ericcrosson-bitgo · 2025-07-17T19:36:06Z

packages/typed-express-router/src/errors.ts

+  _req,
+) => 400;
+
+export const defaultEncodeErrorFormatter: EncodeErrorFormatterFn = () => ({});


ericcrosson-bitgo · 2025-07-17T19:37:58Z

packages/typed-express-router/test/server.test.ts

-    onEncodeError: (_err, _req, res) => {
-      res.status(500).json('Custom encode error').end();
+    encodeErrorFormatter: (_err, _req) => {
+      return 'Custom encode error';


praise: Look at all that data instead of state! 😍

ericcrosson-bitgo · 2025-07-17T19:42:13Z

packages/typed-express-router/test/telemetry.test.ts

+import { createRouter } from '../src';
+import assert from 'node:assert';
+import { ApiTsAttributes } from '../src/telemetry';
+import test, { beforeEach, afterEach } from 'node:test';


quibble: please separate imports into the following sections, with sections separated by a single newline:

Native node imports (begin with node:)

Imports from a named package

Relative imports

Note: Not blocking change, can be done in a follow-up PR.

ericcrosson-bitgo · 2025-07-17T19:43:10Z

packages/typed-express-router/test/telemetry.test.ts

+  body?: any,
+): Promise<{ statusCode: number; data: string }> => {
+  return new Promise((resolve, reject) => {
+    const url = `http://localhost:${(server.address() as any).port}${path}`;


question: LSP says server.address() is of type string | AddressInfo | null -- how do you always know it is of type AddressInfo here? I wonder if there's a way to clean up the type cast.

ericcrosson-bitgo · 2025-07-17T19:45:31Z

packages/typed-express-router/test/telemetry.test.ts

+const GetHello = httpRoute({
+  path: '/hello/{id}',
+  method: 'GET',
+  request: httpRequest({
+    params: {
+      id: t.string,
+    },
+  }),
+  response: {
+    200: t.type({
+      id: t.string,
+    }),
+  },
+});
+


quibble: Please use the conventional order of GET, POST, PUT, DELETE, PATCH, by moving this GET operation above the PUT operation declared for the same path on line 58.

api-ts/packages/typed-express-router/src/index.ts

Lines 190 to 194 in a203328

get: makeAddRoute('get'),

post: makeAddRoute('post'),

put: makeAddRoute('put'),

delete: makeAddRoute('delete'),

patch: makeAddRoute('patch'),

Note: Not a blocking change, can be done in a follow-up PR.

ericcrosson-bitgo · 2025-07-17T19:46:12Z

packages/typed-express-router/test/telemetry.test.ts

+    put: PutHello,
+    get: GetHello,


quibble: For the same reason as above, please use the order of GET, POST, PUT, DELETE, PATCH

Note: Not a blocking change, can be done in a follow-up PR.

ericcrosson-bitgo · 2025-07-17T19:52:54Z

packages/typed-express-router/test/telemetry.test.ts

+      decodeSpan?.attributes?.[ApiTsAttributes.API_TS_PATH],
+      '/hello/{id}',
+    );
+    assert.strictEqual(decodeSpan?.attributes?.[ApiTsAttributes.API_TS_METHOD], 'GET');


shorthand now as we are on a call: please update ordering to match the order keys are introduced in the object definition

Note: Not a blocking change, can be done in a follow-up PR.

ericcrosson-bitgo · 2025-07-17T19:53:05Z

packages/typed-express-router/test/telemetry.test.ts

+
+// TODO: POST
+// TODO: DELETE
+// TODO: PATCH


ericcrosson-bitgo · 2025-07-17T20:06:02Z

packages/typed-express-router/test/telemetry.test.ts

+    // Find encode span
+    const decodeSpan = spans.find(


noting irregular use of encode/decode

starfy84 self-assigned this Jun 25, 2025

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch 2 times, most recently from 9c177cd to 0bff27e Compare June 26, 2025 15:07

starfy84 marked this pull request as ready for review June 26, 2025 15:15

starfy84 requested a review from a team as a code owner June 26, 2025 15:15

ericcrosson-bitgo requested changes Jun 27, 2025

View reviewed changes

github-advanced-security bot found potential problems Jun 30, 2025

View reviewed changes

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 43daf20 to 3781856 Compare June 30, 2025 15:38

github-advanced-security bot found potential problems Jun 30, 2025

View reviewed changes

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts Fixed Show fixed Hide fixed

packages/opentelemetry-instrumentation-typed-express-router/test/integration.test.ts Fixed Show fixed Hide fixed

ericcrosson-bitgo marked this pull request as draft June 30, 2025 20:15

github-advanced-security bot found potential problems Jul 2, 2025

View reviewed changes

github-advanced-security bot found potential problems Jul 7, 2025

View reviewed changes

packages/opentelemetry-instrumentation-typed-express-router/src/instrumentation.ts Fixed Show fixed Hide fixed

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch 4 times, most recently from 6cd264b to 11fc7f0 Compare July 9, 2025 16:24

starfy84 commented Jul 9, 2025

View reviewed changes

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from f804fb4 to 0158ca3 Compare July 9, 2025 16:28

starfy84 marked this pull request as ready for review July 9, 2025 16:30

starfy84 requested a review from ericcrosson-bitgo July 9, 2025 16:30

starfy84 changed the base branch from master to beta July 9, 2025 19:55

ericcrosson-bitgo marked this pull request as draft July 10, 2025 21:38

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from a224511 to ab8a123 Compare July 15, 2025 15:19

starfy84 commented Jul 15, 2025

View reviewed changes

packages/express-wrapper/src/request.ts Outdated Show resolved Hide resolved

ericcrosson-bitgo reviewed Jul 15, 2025

View reviewed changes

packages/typed-express-router/src/errors.ts Outdated Show resolved Hide resolved

ericcrosson-bitgo reviewed Jul 17, 2025

View reviewed changes

packages/typed-express-router/src/types.ts Outdated Show resolved Hide resolved

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 183d5f4 to 3cfad4e Compare July 17, 2025 18:49

starfy84 force-pushed the DX-1473-create-otel-wrapper-for-typed-express-router branch from 3cfad4e to 4248ffd Compare July 17, 2025 18:52

starfy84 marked this pull request as ready for review July 17, 2025 18:59

ericcrosson-bitgo reviewed Jul 17, 2025

View reviewed changes

	get: makeAddRoute('get'),
	post: makeAddRoute('post'),
	put: makeAddRoute('put'),
	delete: makeAddRoute('delete'),
	patch: makeAddRoute('patch'),

feat(opentelemetry): create otel instrumentation for typed-express-router #1044

Are you sure you want to change the base?

feat(opentelemetry): create otel instrumentation for typed-express-router #1044

Uh oh!

Conversation

starfy84 commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ericcrosson-bitgo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ericcrosson-bitgo Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

starfy84 commented Jun 25, 2025 •

edited

Loading

ericcrosson-bitgo Jul 17, 2025 •

edited

Loading